Add "lexical context" information to the macro expansion context #1554
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@swift-ci please test |
DougGregor
force-pushed
the
parent-context-of-macro
branch
from
db6a793 to
63606b0
Compare
|
@swift-ci please test |
ahoppen
reviewed
Apr 17, 2023
Comment on lines
77
to
78
| if firstName.text != "_", parameterHasArgumentLabelByDefault | ||
| { |
There was a problem hiding this comment.
Suggested change
| if firstName.text != "_", parameterHasArgumentLabelByDefault | |
| { | |
| if firstName.text != "_", parameterHasArgumentLabelByDefault { |
| extension SyntaxProtocol { | ||
| /// Form a function name. | ||
| private func formFunctionName( | ||
| _ baseName: String, _ parameters: ParameterClauseSyntax?, |
There was a problem hiding this comment.
baseName could just be a TokenSyntax. Then you could use .init instead of "init" below
|
|
||
| // Extensions | ||
| if let extensionDecl = self.as(ExtensionDeclSyntax.self) { | ||
| // FIXME: It would be nice to be able to switch on type syntax... |
There was a problem hiding this comment.
You could switch over extensionDecl.kind and then get the meta type using SyntaxKind.syntaxNodeType. You could also use that above.
| return #""<unknown>""# | ||
| } | ||
|
|
||
| return ExprSyntax("\(literal: name)").with(\.leadingTrivia, node.leadingTrivia) |
There was a problem hiding this comment.
You probably also want to retain the node’s trailing trivia, right?
| @@ -769,6 +889,70 @@ final class MacroSystemTests: XCTestCase { | |||
| ) | |||
| } | |||
|
|
|||
| func testPoundFunction() { | |||
| assertMacroExpansion( | |||
There was a problem hiding this comment.
I would prefer to have a separate assertMacroExpansion invocation for each #function. In my experience that makes it a lot easier to
a) check how #function is being transformed in each case and
b) debug the test case if something is going wrong
The lexical context of a particular macro expansion involves all of the enclosing contexts, including functions, types and extensions, properties and subscripts, and so on. The lexical context stack can be used to, for example, determine which type a macro was expanded within, or gather the parameters of the enclosing function for an assertion, etc.
DougGregor
force-pushed
the
parent-context-of-macro
branch
from
63606b0 to
5c47c90
Compare
DougGregor
changed the title
|
@swift-ci please test |
kastiglione
reviewed
Feb 3, 2024
| /// blocks removed. | ||
| /// | ||
| /// The first entry in the array is the innermost context, which could be | ||
| /// the syntax node to which |
There was a problem hiding this comment.
also an unfinished comment.
ahoppen
reviewed
Feb 3, 2024
Sources/SwiftCompilerPluginMessageHandling/PluginMessages.swift
Outdated
Show resolved
Hide resolved
|
@swift-ci please test |
|
@swift-ci please test Windows |
1 similar comment
|
@swift-ci please test Windows |
|
@swift-ci test Windows |
2 tasks
grynspan
added a commit
to swiftlang/swift-testing
that referenced
this pull request
Apr 1, 2024
This PR conditionally adopts the new `lexicalContext` member of `MacroExpansionContext` added in swiftlang/swift-syntax#1554. If the SwiftSyntax600 pseudo-module is available, then this member should be available for use and can be used to perform additional diagnostics for tests and to get the names of their containing types. With this PR, if built against an older toolchain (5.11 or earlier), the old hacky "is there leading whitespace?" mechanism is still used. A future PR will recursively perform suite-level diagnostics on the lexical contexts containing tests and suites, so that a test cannot be (easily) inserted into a type that cannot be used as a suite. Resolves rdar://109439578.
grynspan
added a commit
to swiftlang/swift-testing
that referenced
this pull request
Apr 1, 2024
This PR conditionally adopts the new `lexicalContext` member of `MacroExpansionContext` added in swiftlang/swift-syntax#1554. If the SwiftSyntax600 pseudo-module is available, then this member should be available for use and can be used to perform additional diagnostics for tests and to get the names of their containing types. With this PR, if built against an older toolchain (5.11 or earlier), the old hacky "is there leading whitespace?" mechanism is still used. A future PR will recursively perform suite-level diagnostics on the lexical contexts containing tests and suites, so that a test cannot be (easily) inserted into a type that cannot be used as a suite. Resolves rdar://109439578. ### Checklist: - [x] Code and documentation should follow the style of the [Style Guide](https://github.com/apple/swift-testing/blob/main/Documentation/StyleGuide.md). - [x] If public symbols are renamed or modified, DocC references should be updated.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The lexical context of a particular macro expansion involves all of the
enclosing contexts, including functions, types and extensions,
properties and subscripts, and so on. The lexical context stack can be
used to, for example, determine which type a macro was expanded
within, or gather the parameters of the enclosing function for an
assertion, etc.